<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.math3.geometry.partitioning;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import org.apache.commons.math3.geometry.Space;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.apache.commons.math3.geometry.Vector;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    /** This interface represents a region of a space as a partition.<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>     * &lt;p&gt;Region are subsets of a space, they can be infinite (whole<a name="line.24"></a>
<FONT color="green">025</FONT>     * space, half space, infinite stripe ...) or finite (polygons in 2D,<a name="line.25"></a>
<FONT color="green">026</FONT>     * polyhedrons in 3D ...). Their main characteristic is to separate<a name="line.26"></a>
<FONT color="green">027</FONT>     * points that are considered to be &lt;em&gt;inside&lt;/em&gt; the region from<a name="line.27"></a>
<FONT color="green">028</FONT>     * points considered to be &lt;em&gt;outside&lt;/em&gt; of it. In between, there<a name="line.28"></a>
<FONT color="green">029</FONT>     * may be points on the &lt;em&gt;boundary&lt;/em&gt; of the region.&lt;/p&gt;<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>     * &lt;p&gt;This implementation is limited to regions for which the boundary<a name="line.31"></a>
<FONT color="green">032</FONT>     * is composed of several {@link SubHyperplane sub-hyperplanes},<a name="line.32"></a>
<FONT color="green">033</FONT>     * including regions with no boundary at all: the whole space and the<a name="line.33"></a>
<FONT color="green">034</FONT>     * empty region. They are not necessarily finite and not necessarily<a name="line.34"></a>
<FONT color="green">035</FONT>     * path-connected. They can contain holes.&lt;/p&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>    <a name="line.36"></a>
<FONT color="green">037</FONT>     * &lt;p&gt;Regions can be combined using the traditional sets operations :<a name="line.37"></a>
<FONT color="green">038</FONT>     * union, intersection, difference and symetric difference (exclusive<a name="line.38"></a>
<FONT color="green">039</FONT>     * or) for the binary operations, complement for the unary<a name="line.39"></a>
<FONT color="green">040</FONT>     * operation.&lt;/p&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>    <a name="line.41"></a>
<FONT color="green">042</FONT>     * @param &lt;S&gt; Type of the space.<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>     * @version $Id: Region.java 1416643 2012-12-03 19:37:14Z tn $<a name="line.44"></a>
<FONT color="green">045</FONT>     * @since 3.0<a name="line.45"></a>
<FONT color="green">046</FONT>     */<a name="line.46"></a>
<FONT color="green">047</FONT>    public interface Region&lt;S extends Space&gt; {<a name="line.47"></a>
<FONT color="green">048</FONT>    <a name="line.48"></a>
<FONT color="green">049</FONT>        /** Enumerate for the location of a point with respect to the region. */<a name="line.49"></a>
<FONT color="green">050</FONT>        public static enum Location {<a name="line.50"></a>
<FONT color="green">051</FONT>            /** Code for points inside the partition. */<a name="line.51"></a>
<FONT color="green">052</FONT>            INSIDE,<a name="line.52"></a>
<FONT color="green">053</FONT>    <a name="line.53"></a>
<FONT color="green">054</FONT>            /** Code for points outside of the partition. */<a name="line.54"></a>
<FONT color="green">055</FONT>            OUTSIDE,<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>            /** Code for points on the partition boundary. */<a name="line.57"></a>
<FONT color="green">058</FONT>            BOUNDARY;<a name="line.58"></a>
<FONT color="green">059</FONT>        }<a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>        /** Build a region using the instance as a prototype.<a name="line.61"></a>
<FONT color="green">062</FONT>         * &lt;p&gt;This method allow to create new instances without knowing<a name="line.62"></a>
<FONT color="green">063</FONT>         * exactly the type of the region. It is an application of the<a name="line.63"></a>
<FONT color="green">064</FONT>         * prototype design pattern.&lt;/p&gt;<a name="line.64"></a>
<FONT color="green">065</FONT>         * &lt;p&gt;The leaf nodes of the BSP tree &lt;em&gt;must&lt;/em&gt; have a<a name="line.65"></a>
<FONT color="green">066</FONT>         * {@code Boolean} attribute representing the inside status of<a name="line.66"></a>
<FONT color="green">067</FONT>         * the corresponding cell (true for inside cells, false for outside<a name="line.67"></a>
<FONT color="green">068</FONT>         * cells). In order to avoid building too many small objects, it is<a name="line.68"></a>
<FONT color="green">069</FONT>         * recommended to use the predefined constants<a name="line.69"></a>
<FONT color="green">070</FONT>         * {@code Boolean.TRUE} and {@code Boolean.FALSE}. The<a name="line.70"></a>
<FONT color="green">071</FONT>         * tree also &lt;em&gt;must&lt;/em&gt; have either null internal nodes or<a name="line.71"></a>
<FONT color="green">072</FONT>         * internal nodes representing the boundary as specified in the<a name="line.72"></a>
<FONT color="green">073</FONT>         * {@link #getTree getTree} method).&lt;/p&gt;<a name="line.73"></a>
<FONT color="green">074</FONT>         * @param newTree inside/outside BSP tree representing the new region<a name="line.74"></a>
<FONT color="green">075</FONT>         * @return the built region<a name="line.75"></a>
<FONT color="green">076</FONT>         */<a name="line.76"></a>
<FONT color="green">077</FONT>        Region&lt;S&gt; buildNew(BSPTree&lt;S&gt; newTree);<a name="line.77"></a>
<FONT color="green">078</FONT>    <a name="line.78"></a>
<FONT color="green">079</FONT>        /** Copy the instance.<a name="line.79"></a>
<FONT color="green">080</FONT>         * &lt;p&gt;The instance created is completely independant of the original<a name="line.80"></a>
<FONT color="green">081</FONT>         * one. A deep copy is used, none of the underlying objects are<a name="line.81"></a>
<FONT color="green">082</FONT>         * shared (except for the underlying tree {@code Boolean}<a name="line.82"></a>
<FONT color="green">083</FONT>         * attributes and immutable objects).&lt;/p&gt;<a name="line.83"></a>
<FONT color="green">084</FONT>         * @return a new region, copy of the instance<a name="line.84"></a>
<FONT color="green">085</FONT>         */<a name="line.85"></a>
<FONT color="green">086</FONT>        Region&lt;S&gt; copySelf();<a name="line.86"></a>
<FONT color="green">087</FONT>    <a name="line.87"></a>
<FONT color="green">088</FONT>        /** Check if the instance is empty.<a name="line.88"></a>
<FONT color="green">089</FONT>         * @return true if the instance is empty<a name="line.89"></a>
<FONT color="green">090</FONT>         */<a name="line.90"></a>
<FONT color="green">091</FONT>        boolean isEmpty();<a name="line.91"></a>
<FONT color="green">092</FONT>    <a name="line.92"></a>
<FONT color="green">093</FONT>        /** Check if the sub-tree starting at a given node is empty.<a name="line.93"></a>
<FONT color="green">094</FONT>         * @param node root node of the sub-tree (&lt;em&gt;must&lt;/em&gt; have {@link<a name="line.94"></a>
<FONT color="green">095</FONT>         * Region Region} tree semantics, i.e. the leaf nodes must have<a name="line.95"></a>
<FONT color="green">096</FONT>         * {@code Boolean} attributes representing an inside/outside<a name="line.96"></a>
<FONT color="green">097</FONT>         * property)<a name="line.97"></a>
<FONT color="green">098</FONT>         * @return true if the sub-tree starting at the given node is empty<a name="line.98"></a>
<FONT color="green">099</FONT>         */<a name="line.99"></a>
<FONT color="green">100</FONT>        boolean isEmpty(final BSPTree&lt;S&gt; node);<a name="line.100"></a>
<FONT color="green">101</FONT>    <a name="line.101"></a>
<FONT color="green">102</FONT>        /** Check if the instance entirely contains another region.<a name="line.102"></a>
<FONT color="green">103</FONT>         * @param region region to check against the instance<a name="line.103"></a>
<FONT color="green">104</FONT>         * @return true if the instance contains the specified tree<a name="line.104"></a>
<FONT color="green">105</FONT>         */<a name="line.105"></a>
<FONT color="green">106</FONT>        boolean contains(final Region&lt;S&gt; region);<a name="line.106"></a>
<FONT color="green">107</FONT>    <a name="line.107"></a>
<FONT color="green">108</FONT>        /** Check a point with respect to the region.<a name="line.108"></a>
<FONT color="green">109</FONT>         * @param point point to check<a name="line.109"></a>
<FONT color="green">110</FONT>         * @return a code representing the point status: either {@link<a name="line.110"></a>
<FONT color="green">111</FONT>         * Location#INSIDE}, {@link Location#OUTSIDE} or {@link Location#BOUNDARY}<a name="line.111"></a>
<FONT color="green">112</FONT>         */<a name="line.112"></a>
<FONT color="green">113</FONT>        Location checkPoint(final Vector&lt;S&gt; point);<a name="line.113"></a>
<FONT color="green">114</FONT>    <a name="line.114"></a>
<FONT color="green">115</FONT>        /** Get the underlying BSP tree.<a name="line.115"></a>
<FONT color="green">116</FONT>    <a name="line.116"></a>
<FONT color="green">117</FONT>         * &lt;p&gt;Regions are represented by an underlying inside/outside BSP<a name="line.117"></a>
<FONT color="green">118</FONT>         * tree whose leaf attributes are {@code Boolean} instances<a name="line.118"></a>
<FONT color="green">119</FONT>         * representing inside leaf cells if the attribute value is<a name="line.119"></a>
<FONT color="green">120</FONT>         * {@code true} and outside leaf cells if the attribute is<a name="line.120"></a>
<FONT color="green">121</FONT>         * {@code false}. These leaf attributes are always present and<a name="line.121"></a>
<FONT color="green">122</FONT>         * guaranteed to be non null.&lt;/p&gt;<a name="line.122"></a>
<FONT color="green">123</FONT>    <a name="line.123"></a>
<FONT color="green">124</FONT>         * &lt;p&gt;In addition to the leaf attributes, the internal nodes which<a name="line.124"></a>
<FONT color="green">125</FONT>         * correspond to cells split by cut sub-hyperplanes may contain<a name="line.125"></a>
<FONT color="green">126</FONT>         * {@link BoundaryAttribute BoundaryAttribute} objects representing<a name="line.126"></a>
<FONT color="green">127</FONT>         * the parts of the corresponding cut sub-hyperplane that belong to<a name="line.127"></a>
<FONT color="green">128</FONT>         * the boundary. When the boundary attributes have been computed,<a name="line.128"></a>
<FONT color="green">129</FONT>         * all internal nodes are guaranteed to have non-null<a name="line.129"></a>
<FONT color="green">130</FONT>         * attributes, however some {@link BoundaryAttribute<a name="line.130"></a>
<FONT color="green">131</FONT>         * BoundaryAttribute} instances may have their {@link<a name="line.131"></a>
<FONT color="green">132</FONT>         * BoundaryAttribute#plusInside plusInside} and {@link<a name="line.132"></a>
<FONT color="green">133</FONT>         * BoundaryAttribute#plusOutside plusOutside} fields both null if<a name="line.133"></a>
<FONT color="green">134</FONT>         * the corresponding cut sub-hyperplane does not have any parts<a name="line.134"></a>
<FONT color="green">135</FONT>         * belonging to the boundary.&lt;/p&gt;<a name="line.135"></a>
<FONT color="green">136</FONT>    <a name="line.136"></a>
<FONT color="green">137</FONT>         * &lt;p&gt;Since computing the boundary is not always required and can be<a name="line.137"></a>
<FONT color="green">138</FONT>         * time-consuming for large trees, these internal nodes attributes<a name="line.138"></a>
<FONT color="green">139</FONT>         * are computed using lazy evaluation only when required by setting<a name="line.139"></a>
<FONT color="green">140</FONT>         * the {@code includeBoundaryAttributes} argument to<a name="line.140"></a>
<FONT color="green">141</FONT>         * {@code true}. Once computed, these attributes remain in the<a name="line.141"></a>
<FONT color="green">142</FONT>         * tree, which implies that in this case, further calls to the<a name="line.142"></a>
<FONT color="green">143</FONT>         * method for the same region will always include these attributes<a name="line.143"></a>
<FONT color="green">144</FONT>         * regardless of the value of the<a name="line.144"></a>
<FONT color="green">145</FONT>         * {@code includeBoundaryAttributes} argument.&lt;/p&gt;<a name="line.145"></a>
<FONT color="green">146</FONT>    <a name="line.146"></a>
<FONT color="green">147</FONT>         * @param includeBoundaryAttributes if true, the boundary attributes<a name="line.147"></a>
<FONT color="green">148</FONT>         * at internal nodes are guaranteed to be included (they may be<a name="line.148"></a>
<FONT color="green">149</FONT>         * included even if the argument is false, if they have already been<a name="line.149"></a>
<FONT color="green">150</FONT>         * computed due to a previous call)<a name="line.150"></a>
<FONT color="green">151</FONT>         * @return underlying BSP tree<a name="line.151"></a>
<FONT color="green">152</FONT>         * @see BoundaryAttribute<a name="line.152"></a>
<FONT color="green">153</FONT>         */<a name="line.153"></a>
<FONT color="green">154</FONT>        BSPTree&lt;S&gt; getTree(final boolean includeBoundaryAttributes);<a name="line.154"></a>
<FONT color="green">155</FONT>    <a name="line.155"></a>
<FONT color="green">156</FONT>        /** Get the size of the boundary.<a name="line.156"></a>
<FONT color="green">157</FONT>         * @return the size of the boundary (this is 0 in 1D, a length in<a name="line.157"></a>
<FONT color="green">158</FONT>         * 2D, an area in 3D ...)<a name="line.158"></a>
<FONT color="green">159</FONT>         */<a name="line.159"></a>
<FONT color="green">160</FONT>        double getBoundarySize();<a name="line.160"></a>
<FONT color="green">161</FONT>    <a name="line.161"></a>
<FONT color="green">162</FONT>        /** Get the size of the instance.<a name="line.162"></a>
<FONT color="green">163</FONT>         * @return the size of the instance (this is a length in 1D, an area<a name="line.163"></a>
<FONT color="green">164</FONT>         * in 2D, a volume in 3D ...)<a name="line.164"></a>
<FONT color="green">165</FONT>         */<a name="line.165"></a>
<FONT color="green">166</FONT>        double getSize();<a name="line.166"></a>
<FONT color="green">167</FONT>    <a name="line.167"></a>
<FONT color="green">168</FONT>        /** Get the barycenter of the instance.<a name="line.168"></a>
<FONT color="green">169</FONT>         * @return an object representing the barycenter<a name="line.169"></a>
<FONT color="green">170</FONT>         */<a name="line.170"></a>
<FONT color="green">171</FONT>        Vector&lt;S&gt; getBarycenter();<a name="line.171"></a>
<FONT color="green">172</FONT>    <a name="line.172"></a>
<FONT color="green">173</FONT>        /** Compute the relative position of the instance with respect to an<a name="line.173"></a>
<FONT color="green">174</FONT>         * hyperplane.<a name="line.174"></a>
<FONT color="green">175</FONT>         * @param hyperplane reference hyperplane<a name="line.175"></a>
<FONT color="green">176</FONT>         * @return one of {@link Side#PLUS Side.PLUS}, {@link Side#MINUS<a name="line.176"></a>
<FONT color="green">177</FONT>         * Side.MINUS}, {@link Side#BOTH Side.BOTH} or {@link Side#HYPER<a name="line.177"></a>
<FONT color="green">178</FONT>         * Side.HYPER} (the latter result can occur only if the tree<a name="line.178"></a>
<FONT color="green">179</FONT>         * contains only one cut hyperplane)<a name="line.179"></a>
<FONT color="green">180</FONT>         */<a name="line.180"></a>
<FONT color="green">181</FONT>        Side side(final Hyperplane&lt;S&gt; hyperplane);<a name="line.181"></a>
<FONT color="green">182</FONT>    <a name="line.182"></a>
<FONT color="green">183</FONT>        /** Get the parts of a sub-hyperplane that are contained in the region.<a name="line.183"></a>
<FONT color="green">184</FONT>         * &lt;p&gt;The parts of the sub-hyperplane that belong to the boundary are<a name="line.184"></a>
<FONT color="green">185</FONT>         * &lt;em&gt;not&lt;/em&gt; included in the resulting parts.&lt;/p&gt;<a name="line.185"></a>
<FONT color="green">186</FONT>         * @param sub sub-hyperplane traversing the region<a name="line.186"></a>
<FONT color="green">187</FONT>         * @return filtered sub-hyperplane<a name="line.187"></a>
<FONT color="green">188</FONT>         */<a name="line.188"></a>
<FONT color="green">189</FONT>        SubHyperplane&lt;S&gt; intersection(final SubHyperplane&lt;S&gt; sub);<a name="line.189"></a>
<FONT color="green">190</FONT>    <a name="line.190"></a>
<FONT color="green">191</FONT>    }<a name="line.191"></a>




























































</PRE>
</BODY>
</HTML>
